home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDUCATE / YRWAY22.ARJ / YRWAY.DOC < prev    next >
Text File  |  1992-03-10  |  24KB  |  565 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                YRWAY Version 2.2
  12.                      Copyright 1992, All Rights Reserved
  13.  
  14.                       Developed and Marketed as Shareware
  15.                                       by
  16.                                 Larry O. Edwards
  17.                                  P.O. Box 3429
  18.                                 Kent, WA. 98032
  19.                               CompuServe: 74010,773
  20.  
  21.                                  _______
  22.                             ____|__     |                (R)
  23.                          --|       |    |-------------------
  24.                            |   ____|__  |  Association of
  25.                            |  |       |_|  Shareware
  26.                            |__|   o   |    Professionals
  27.                          -----|   |   |---------------------
  28.                               |___|___|    MEMBER
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.                     D I S C L A I M E R  -  A G R E E M E N T
  43.  
  44.               If you use YRWAY, you must accept this disclaimer of warranty.
  45.               The author disclaims all warranties, expressed or implied,
  46.               including, without limitation, the warranties of
  47.               merchantability and of fitness for any purpose. The author
  48.               assumes no liability for damages, direct or consequential,
  49.               which may result from the use of YRWAY."
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                   Y R   W A Y
  56.  
  57.                             D O C U M E N T A T I O N
  58.  
  59.                                  Table of Contents
  60.      Topic                                                         Page
  61.  
  62. Introduction ...................................................... 1
  63. What is Shareware? ................................................ 1
  64. Registration ...................................................... 2
  65. What Do I Get for Registering, and Why Should I? .................. 2
  66. Installation and Operation ........................................ 3
  67.    Upgrading from prior version ................................... 3
  68.    Configuring for first time use ................................. 3
  69.    Editing a Subject Database ..................................... 5
  70.    Operation ...................................................... 7
  71.    Changing the configuration ..................................... 7
  72.  
  73. How to Reach the Author ........................................... 8
  74. Final Remarks ..................................................... 8
  75.  
  76.  
  77.  
  78.    Introduction
  79.    ------------
  80.    YRWAY is designed to aid the student in studying for tests. It is
  81.    designed to be fully configurable for the student with the ability to add
  82.    or delete their own subjects and answers in the language of their choice.
  83.    I consider it useful to all students as it provides a fully configurable
  84.    program that allows the student to match it with their needs. With the
  85.    ability to change the subjects it can be tailored to meet any age group
  86.    and then can GROW with the students abilities.
  87.    This program is a variation of my "TEACHER" works, except it allows the
  88.    user to use it with ANY subject and in most languages. It primarily is a
  89.    shell type program that lets you make it fit your needs.
  90.  
  91.  
  92.  
  93.  
  94.  
  95.    What is Shareware?
  96.    ------------------
  97.    Shareware is a form of distribution which gives users a chance to try
  98.    software before buying it. If you try a Shareware program and continue
  99.    to use it, you are expected to register.  Individual programs differ on
  100.    details -- some request registration while others require it, some
  101.    specify a maximum trial period.  With registration, you get anything
  102.    from the simple right to continue using the software to an updated
  103.    program with printed manual.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.                                                                        Pg. 1
  115.  
  116.  
  117.  
  118.    Registration
  119.    ------------
  120.    If you find YRWAY useful and you continue to use it after a reasonable
  121.    (30 days) trial period, you are required to make a registration payment
  122.    of  $15.00 to Larry Edwards. See "REGIS.TXT" for more information.
  123.    The $15.00 registration fee will license one copy for use on any one
  124.    computer at any one time.
  125.  
  126.    You must treat a registered version of this software just like a book.
  127.    Just as a book cannot be read by two different persons at the same time,
  128.    this software may be used by any number of people and may be freely moved
  129.    from one computer location to another, as long as there is no possibility
  130.    of it being used in two different locations at the same time.
  131.  
  132.    Commercial users of YRWAY  must register and pay for their copies of the
  133.    program within 30 days of first use or their license is withdrawn.  For
  134.    site-license information, contact the author direct.
  135.  
  136.    You are encouraged to pass (unregistered) copies of YRWAY along
  137.    to your friends for evaluation.  Please encourage them to register their
  138.    copy if they find that they can use it.  All registered users will
  139.    receive a copy of the latest version of YRWAY they register.
  140.  
  141.    Though the program is not "crippled" in anyway, this shareware version
  142.    shows an "Unregistered " status message in the Main Menu Screen on
  143.    start up to encourage you to register the program.
  144.  
  145.    Please fill out the included registration order form (file REGIS.TXT)
  146.    and send in your registration today.  You can send REGIS.TXT to your
  147.    printer by typing:
  148.  
  149.                 "COPY REGIS.TXT PRN"  (without the quotes)
  150.  
  151.    and then pressing ENTER while at the MS-DOS prompt.
  152.  
  153.  
  154.    What Do I Get for Registering, and Why Should I?
  155.    ------------------------------------------------
  156.  
  157.    Here are some reasons why you should register:
  158.  
  159.    o Once registration is received you will have instant access to the
  160.      author's BBS to download YOUR "KEY" and the latest version that
  161.      your "KEY" will work with.
  162.    o You receive a CURRENT copy of the program, and a "KEY" program that
  163.      will "stamp" your reg. number on future versions, by U.S. Mail.
  164.    o You get a LIFETIME license, meaning you're entitled to all future
  165.      versions/upgrades of YRWAY. You may get the latest version thru my
  166.      BBS, or by returning your original disk to the author.
  167.    o You get unlimited technical support via surface mail or electronic
  168.      mail.
  169.    o You have the author's ear when it comes to suggesting new features
  170.      and capabilities.
  171.    o You help increase competition in the software industry by keeping
  172.      prices low (shareware doesn't rely on expensive advertising).
  173.    o Finally, you can be proud of the honesty and integrity you've shown
  174.      in registering the program and having participated in the Shareware
  175.      revolution.
  176.  
  177.  
  178.                                                                        Pg. 2
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.    Installation and Operation
  186.    --------------------------
  187.  
  188.  
  189.    Upgrading from a prior version
  190.    ------------------------------
  191.  
  192.    This version of YRWAY will work with your old .Dat files. If you wish
  193.    to use them copy them to a safe area, then once you have run the new
  194.    configuration program copy them back into the directory you are using
  195.    for YRWAY. The new configuration program will write new .DAT files, if
  196.    prompted if you want to overwrite them answer YES. The old YRWAY.CFG
  197.    file is NOT compatible with this version so can not be used and should be
  198.    deleted. From the DOS prompt type "DEL YRWAY.CFG" without the quotes. If
  199.    you are using your old .DAT files be sure to name the "TOPIC" areas, in
  200.    the new configuration program, the same as they are in your old version.
  201.    Copy all other files over the old ones.
  202.  
  203.    Configuring for first time use
  204.    ------------------------------
  205.  
  206.    To begin I suggest you create a directory on your hard drive, such as
  207.    C:\YRWAY. Then copy all the files into this directory.
  208.    Before you can use YRWAY you must first tell it how to look. This program
  209.    was designed to be flexible for use with most languages and can be edited
  210.    to reflect different looks for different languages. You MUST run the new
  211.    "YRCFG.EXE" program, type YRCFG then press <ENTER>. Once the program
  212.    starts you will have the option to continue or stop if you want to make
  213.    a change before starting the full configuration. If you elect to continue
  214.    you will see a screen like below.
  215. .............................................................................
  216.  
  217.  ╔═ Mon Feb 10 1992 ═══════════════════════════════════════════ 03:46:32 pm ═╗
  218.  ║ ╒═════════════════════════════ YRWAY 2.2  ══════════════════════════════╕ ║
  219.  ║ │ TOPIC1   TOPIC2   TOPIC3    TOPIC4   TOPIC5   TOPIC6   EDIT    QUIT   │ ║
  220.  ║ ╘═══════════════════════════════════════════════════════════════════════╛ ║
  221.      ^^^^^^
  222.  Please enter the name of the FIRST Topic of Study.
  223.  Maximum of 6 letters.
  224.  This Topic will be placed as indicated above on the MAIN MENU.
  225.  
  226. .............................................................................
  227.  
  228.    This screen represents the top section of the MAIN Menu. Enter whatever
  229.    name you want the first "TOPIC" of study to be. It MUST be 6 letters or
  230.    less with no characters like ","  or ".". LETTERS OR NUMERALS ONLY. Once
  231.    you have entered YOUR TOPIC hit <ENTER> and it will change TOPIC1 to what
  232.    you entered. It will also create an EMPTY .Dat file for later editing with
  233.    your questions and answers.
  234.  
  235.  
  236.    Once the first TOPIC has been named your next 5 screens will look the same
  237.    with the exception of YOUR Topics name will appear and the indicators(^^^^)
  238.    will move over so you know what you are naming. You will have a TOTAL of
  239.    6 TOPIC areas to use. If you do not want to use all of them, when prompted
  240.    for a name hit <ENTER> and they will be named "BLANK2", "BLANK3" etc. You
  241.    can always change these later by running the configuration program again.
  242.  
  243.                                                                        Pg. 3
  244.  
  245.  
  246.  
  247.  
  248.  
  249.    Once all the "TOPICS" have been named the screen will look like below:
  250.  
  251.  ╔═ Mon Feb 10 1992 ═══════════════════════════════════════════ 03:46:32 pm ═╗
  252.  ║ ╒═════════════════════════════ YRWAY 2.2  ══════════════════════════════╕ ║
  253.  ║ │ TOPIC1   TOPIC2   TOPIC3    TOPIC4   TOPIC5   TOPIC6   EDIT    QUIT   │ ║
  254.  ║ ╘═══════════════════════════════════════════════════════════════════════╛ ║
  255.                                                            ^^^^^^
  256.    At this screen and the next one you will have the option of changing the
  257.    "EDIT" and "QUIT"  commands to whatever you want them to read, as long as
  258.    they MEAN THE SAME in your language. These areas may not be used for a new
  259.    "TOPIC" as they are designed to do a particular duty. If you wish them to
  260.    stay the same simply hit <ENTER> and they will not be changed.
  261.    This completes the MAIN MENU set up and YOUR names will now replace all of
  262.    the above commands on the Main Menu.
  263.  
  264.  
  265.    Now the screen will be changed to look like below.
  266.  
  267. .............................................................................
  268.  
  269.    The following is an example of the QUESTION SCREEN showing placement of
  270.    the prompts you will be asked to change.
  271.  
  272.   ╔═ Mon Feb 10 1992 ═══════════════════════════════════════ 03:46:32 pm ═╗
  273.   ║                                                                       ║
  274.   ║      ┌─────────────────────-> QUESTION                                ║
  275.   ║      │                                                                ║
  276.   ║      │            (Your question will be on this line)                ║
  277.   ║      │                                                                ║
  278.   ║      │    ┌──────────────────> ANSWERS                                ║
  279.   ║      │    │                                                           ║
  280.   ║      │    │             A: (An Answer goes here)                      ║
  281.   ║      │    │             B: (An Answer goes here)                      ║
  282.   ║      │    │             C: (An Answer goes here)                      ║
  283.   ║      │    │             D: (An Answer goes here)                      ║
  284.   ║      │    │                                                           ║
  285.   ║      │    │       Please Enter the Correct Answer:                    ║
  286. ┌────────┼────┘       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ <────────────────────┐
  287. │ ┌──────┘...................................................................│
  288. │ │                                                                          │
  289. │ │This is the "QUESTION" screen, it is here that YOUR questions and possible│
  290. │ │answers will be displayed. On the next 3 prompts you will be asked if you │
  291. │ │wish to change the defaults of "QUESTION", "ANSWERS" and the final prompt │
  292. │ └────────────────────────────────────┘           │                         │
  293. └──────────────────────────────────────────────────┘                         │
  294.    "Please Enter the Correct Answer:" ───────────────────────────────────────┘
  295.  
  296.    ALL of these prompts can be changed to what ever you want them to read in
  297.    whatever language you will be using the program in.
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.                                                                        Pg. 4
  308.  
  309.  
  310.  
  311.  
  312.  
  313.    Following the "QUESTION" screen is the "ERROR" screen, like below.
  314.  
  315. .............................................................................
  316.  
  317.    The following is an example of the ERROR SCREEN showing placement of
  318.    the prompts you will be asked to change.
  319.   ╔═ Mon Feb 10 1992 ═══════════════════════════════════════ 03:46:32 pm ═╗
  320.   ║                                                                       ║
  321.   ║                  ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓               ║
  322.   ║                 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓              ║
  323.   ║                ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓             ║
  324.   ║               ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓            ║
  325.   ║              ▓▓▓▓▓▓▓▓▓▓▓▓▓▀▀▀▀▀▓▓▓▓▓▓▓▓▓▓▀▀▀▀▀▓▓▓▓▓▓▓▓▓▓▓▓▓           ║
  326.   ║              ▓▓▓▓▓▓▓▓▓▓▓▓▓▄▄▄▄▄▓▓▓▓▓▓▓▓▓▓▄▄▄▄▄▓▓▓▓▓▓▓▓▓▓▓▓▓           ║
  327.   ║              ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓           ║
  328.   ║               ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓■▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓            ║
  329.   ║                ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓             ║
  330.   ║                 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓              ║
  331.   ║                   ▓▓▓▓▓▓████████████████████████▓▓▓▓▓▓                ║
  332.   ║                    ▓▓▓▓          WRONG           ▓▓▓▓                 ║
  333.   ║                     ▓▓▓▓████████████████████████▓▓▓▓                  ║
  334.   ║                      ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓                   ║
  335.   ║                                                                       ║
  336.   ║                                You Typed:                             ║
  337.   ║                                                                       ║
  338.   ╚═══════════════════════════════════════════════════════════════════════╝
  339.                             Press <ENTER> to try again
  340. .............................................................................
  341.  
  342.    This screen is displayed when an incorrect answer is picked from the
  343.    Question screen. Here you can change the prompts "WRONG", "You Typed: "
  344.    and "Press <ENTER> to try again" to what they would mean in YOUR language.
  345.  
  346.    After completing these screens you will have the chance to change 2 more
  347.    prompts that are used within the program.
  348.  
  349.    All of your inputs are kept in a file called "YRWAY.CFG" and these may be
  350.    changed at any time by using the YRCFG program. BE WARNED if you change a
  351.    TOPIC NAME the old .DAT file will be deleted and a new one created for the
  352.    new TOPIC. This completes the configuration program.
  353.    IF YOU HAVE ANY PROBLEMS DELETE THE "YRWAY.CFG" FILE and start again.
  354.  
  355.    Adding to the External Data Files
  356.    --------------------------------
  357.    Before you can use the program at least 1 database must be edited, you
  358.    will not be allowed access to a database until it has been edited first.
  359.    You can add your own information to the external database in two ways.
  360.    You can use a text editor or word processor to create and maintain the
  361.    database, or you can use the editor built into the program. If you
  362.    use the built in Editor function (by selecting EDIT at the MAIN MENU) you
  363.    will see a screen that asks you which database to edit. Select the one you
  364.    want and you will see a screen like on the next page.
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.                                                                        Pg. 5
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.   ---------------------------------------------------------------------------
  379.  
  380.    Line: 1       Column : 1      0%      Insert: On     Word wrap: On
  381.   ╒════════════════════════════════════════════════════════════════════════╕
  382.   │                                                                        │
  383.   │                                                                        │
  384.   │                                                                        │
  385.   │                                                                        │
  386.   │                                                                        │
  387.   │                                                                        │
  388.   ╘════════════════════════════════════════════════════════════════════════╛
  389.  
  390.                                   HOW TO EDIT
  391.               Press <PgDn> Key until end of file is reached.
  392.               Line  1 - Enter a question here.
  393.               Line  2 - Enter a possible answer here. This is A
  394.               Line  3 - Enter a possible answer here. This is B
  395.               Line  4 - Enter a possible answer here. This is C
  396.               Line  5 - Enter a possible answer here. This is D
  397.               Line  6 - Enter the CORRECT LETTER here A B C or D.
  398.                  DO NOT LEAVE ANY BLANK LINES BETWEEN PROBLEMS
  399.                                Press <ESC> To Exit
  400.                                   Active Keys
  401.               <PgUp> <PgDn> <Ins> <Del> <Arrows> <End> <Home>
  402.  
  403. -----------------------------------------------------------------------------
  404.    Once you start the built in editor the cursor will be located on line 1,
  405.    This is where you will write in the question you want to ask.
  406.  
  407.    Line: 1       Column : 1      0%      Insert: On     Word wrap: On
  408.   ╒════════════════════════════════════════════════════════════════════════╕
  409.   │What is the meaning of life?                                            │
  410.   │                                                                        │
  411.  
  412.    The next 4 lines will contain possible answers. One MUST BE CORRECT! These
  413.    lines correspond to the selections on the "Question Screen":
  414.                     Line 2 = Answer Selection "A"
  415.                     Line 3 = Answer Selection "B"
  416.                     Line 4 = Answer Selection "C"
  417.                     Line 5 = Answer Selection "D"
  418.  
  419.    Line: 1       Column : 1      0%      Insert: On     Word wrap: On
  420.   ╒════════════════════════════════════════════════════════════════════════╕
  421. 1=│What is the meaning of life?                                            │
  422. 2=│Money                                                                   │
  423. 3=│Happiness                                                               │
  424. 4=│Propagation                                                             │
  425. 5=│Friends                                                                 │
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.                                                                        Pg. 6
  437.  
  438.  
  439.  
  440.  
  441.         Line #6 will contain the CORRECT LETTER response to the question.
  442.  
  443.    Line: 1       Column : 1      0%      Insert: On     Word wrap: On
  444.   ╒════════════════════════════════════════════════════════════════════════╕
  445. 1=│What is the meaning of life?                                            │
  446. 2=│Money                                                                   │
  447. 3=│Happiness                                                               │
  448. 4=│Propagation                                                             │
  449. 5=│Friends                                                                 │
  450. 6=│B                                                                       │
  451.  
  452.        Line 6 MUST contain one of the following...A, B, C, or D.
  453.  
  454.    The next line will be where you start all over again with a new question.
  455.            DO NOT LEAVE any blank lines in these files.
  456.  
  457.    Once you are finished editing a database select <ESC> and you will be asked
  458.    if you want to save any new changes. If you do, select "Y" and the program
  459.    will re-name the OLD database, if one existed, to the same name with the
  460.    extension of .BAK. Then it will write your new database with your new inputs
  461.    If you do not want to save it then select "N" and no changes will take place
  462.    You will now be returned to the Edit selection screen, if you wish to edit
  463.    another database select it and continue or press <ESC> to be returned to the
  464.    Main Menu.
  465.  
  466.    Operation
  467.    ---------
  468.  
  469.    This is the easiest part!! From the Main Menu select the TOPIC you want
  470.    to use and you will be presented with the "Question Screen" showing YOUR
  471.    prompts, questions and answers. Select the correct answer and you will
  472.    see, "CORRECT" pop up on the screen. If you are wrong then the "ERROR
  473.    SCREEN" will be displayed and it will show you what your selection was.
  474.    Press <ENTER> and you will be returned to the "Question Screen" to try
  475.    again. You will not be able to pass the question until you get the answer
  476.    correct.
  477.  
  478.    Changing the configuration
  479.    --------------------------
  480.  
  481.    If you wish to change "TOPICS" or "PROMPTS" simply run the "YRCFG.EXE"
  482.    program and you will be told that a "YRWAY.CFG" file exists. Then asked
  483.    if you want to change it. If you answer Yes you will have the opportunity
  484.    to make changes. REMEMBER: If you make a change to a "TOPIC" the old .DAT
  485.    file will be DELETED. If you want to keep it for future use, rename it or
  486.    move it to a safe area.
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.                                                                        Pg. 7
  500.  
  501.  
  502.  
  503.  
  504.  
  505.    How to Reach the Author
  506.    -----------------------
  507.  
  508.    Larry Edwards
  509.    P.O. Box 3429
  510.    Kent, Wa. 98032
  511.    CIS: 74010,773
  512.  
  513.     I run a Support BBS for my programs. You can contact me direct thru it
  514.     by calling Area Code (206) 852-7708 in Kent, Wa. This line will also
  515.     accept FAX calls. I also monitor CompuServe Information Service in the
  516.     IBMAPP forum
  517.  
  518.  
  519.    Final Remarks
  520.    -------------
  521.  
  522.    Many Thanks to my Wife, Evelyn, for her Friendship, Love, and Support in
  523.    every aspect of my life.  Especially my addiction to computer keyboards.
  524.    Thanks to Henk Olofsen, in Amsterdam, the Netherlands for suggesting the
  525.    need for this type of program. See, authors DO LISTEN.
  526.    Thanks to members of the Association of Shareware Professionals,
  527.    especially Paul Mayer and Bob Falk for advice on shareware and for some
  528.    of the boilerplate text for my documentation.
  529.  
  530.    I've made every effort to provide a safe and stable program, BUT...
  531.    If you find errors or additions, please let me know.
  532.  
  533.    NOTE: Your registration and support for this program will enable me to
  534.    continue to develop YRWAY and add other valuable features in future
  535.    versions.
  536.  
  537.    I'd appreciate bug reports, new feature requests, comments, performance
  538.    problems, constructive criticism, suggestions, additions.
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.                                                                        Pg. 8
  564.  
  565.